Scripting > CxVhs > VhsClient Helper Objects > ListHistoryValuesExReq Object

ListHistoryValuesExReq Object

The ListHistoryValuesExReq object is used in:

Properties

Property SubType Read Only Description

Count

Integer

No

Sets the number of requested values in the array.

Direction

Integer

No

Sets the direction in which the points should be returned.

RollupPeriod

Integer

No

Sets the rollup period. Rollup period refers to the quantity of units in a period. For example, to rollup 30 days, the RollupPeriod is 30 and the RollupUnit is "days."

RollupType

Integer

No

Sets the value entry rollup type. The possible values are listed on the CxRollupType table.

RollupUnits

Integer

No

Sets the rollup units. This refers to time increments, such as seconds, minutes, hours, or days. The possible values are listed on the CxRollupUnits table.

TagString

Variant

No

Sets tag string for a history point tag.

Type: HistoryTagString

TimeOrdinal

Integer

No

Sets the time ordinal property. The time ordinal property is used to differentiate between entries that have the same timestamp value.

TimeStampStart

Date

No

Sets the timestamp for the starting history record of a time period for a given point (Local time without milliseconds).

TimeStampStartMs

Date

No

Sets the timestamp for the starting history record of a time period for a given point (Local time with milliseconds).

TimeStampStartRaw

Date

No

Sets the timestamp for the starting history record of a time period for a given point (UTC time with milliseconds).

TopOfDayHour

Integer

No

The offset value to use if the subunit to the major unit (i.e. hours to a day) does not start at the time unit expected. For example, to accommodate contract days starting at 5 AM, the TopOfDayHour would be 5 (indicating 5 hours from midnight).

UserId

String

No

Sets the network user ID. The user ID is used by the VHS to check security. This property is typically ignored.


Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.